home *** CD-ROM | disk | FTP | other *** search
/ Aminet 50 / Aminet 50 (2002)(GTI - Schatztruhe)[!][Aug 2002].iso / Aminet / comm / misc / FSwatcher.readme < prev    next >
Text File  |  2002-05-24  |  5KB  |  141 lines
  1. Short:    A transfer gauge for downloading a file
  2. Author:   Thomas@Igracki.de
  3. Uploader: Thomas@Igracki.de
  4. Version:  1.4
  5. Type:     comm/misc
  6. Requires: MUI, Textinput.mcc
  7.  
  8.  
  9.    / FSwatcher - FileSizeWatcher /
  10.    ==============================
  11.  
  12. What for is it?
  13.   If you download a file with a program which doesn't have a transfer-
  14.   window showing the current filesize, bps, time togo etc. you should
  15.   try FSwatcher.
  16.  
  17.  
  18. Detailed description:
  19. ---------------------
  20. It opens a small window where you have to specify the filename
  21. and the filesize.
  22. Then press "Start" and the window changes to the gauge, where
  23. the current size in bytes, the bytes transfered per second, the
  24. time since the file was created and the approx. time it takes
  25. to transfer the whole file.
  26. Under the gauge is also a percentage scale.
  27.  
  28. You can also drop a file from a workbench window or dopus lister
  29. anywhere into the window to specify the filename.
  30. If the comment of the filename is set to a number, it will be used
  31. as the total filesize (in bytes).
  32. Also if you press the "Start!" button without specifying a filesize
  33. (-> the "Size:" gadgets contents is "0"), the filesize is read from
  34. the comment of the file.
  35.  
  36. Or you specify the filename and the filesize (if the filename didn't
  37. have its comment set to the filesize) at startup.
  38.  
  39. The values are updated every 3 seconds.
  40.  
  41. When the transfer it finished a requester pops up, saying its
  42. finished;-) You can disable the requester by setting the shell
  43. argument AUTOEXIT to ON or YES at startup, the program then quits
  44. automatically after a download is finished.
  45.  
  46. New in v1.3:
  47. ============
  48. Since v1.3, you can set the environment variable "FSwatcher" to your
  49. default args! Just like as you have typed them on the commandline!
  50. For example: SetEnv SAVE FSwatcher "BPSBar ON"
  51. To implement this I had to change the AUTOEXIT/S arg to a /T arg.
  52. This means you have to put a "ON" or "YES" after the arg to activate
  53. it and a "OFF" or "NO" to deactivate an argument!
  54.  
  55. If you have used programs which used the AUTOEXIT arg, you can patch
  56. them by replacing "AUTOEXIT" with "EXIT YES" or wait for an update
  57. of the program;-)
  58.  
  59.  
  60. New in v1.4:
  61. ============
  62. There is now a button called "!" at the right of the filesize gauge.
  63. If you press this button a script (defaults to s:FSwatcher.bat) is
  64. executed asynchronicly (sp?) with the currently used filename as an
  65. argument.
  66. The included script (s/FSwatcher.bat) supports playing of mp3 songs
  67. (you have to have "mpega" in your search path) and mpg movies via
  68. "frogger" (you have to have it in your search path, or edit the script).
  69. This script makes use of the program MatchPattern which I have
  70. included in this archive (c/MatchPattern).
  71.  
  72.  
  73. Hint:
  74.   You can click on the gauge to get back to the settings page of the
  75.   window.
  76.  
  77. Hint #2:
  78.   The values of the "Name" and "Size" Gadgets are saved after quiting the
  79.   programm in the env and envarc.
  80.  
  81.  
  82. Usage: Name=FileName,Size=FileSize/N,TimeOut/N,Delay=UpdateDelay/N,
  83.        SM=SizeMode,Com=Command,ComCon=CommandConsole,
  84.        BPSBar/T,EXIT=AUTOEXIT/T,QUIET/T
  85.  
  86. FileName, FileSize and AutoExit described above, now lets explain the
  87. other:
  88.  
  89.   TimeOut/N: New in v1.3
  90.      If a transfer is stalled (-> the "---" display) AND AUTOEXIT/T is
  91.      set to ON, the window will close after 'TimeOut' seconds.
  92.      Defaults to 10. You can use values from 0 to 30. 0 means, no timeout.
  93.  
  94.   Name=FileName:
  95.      see above
  96.      
  97.   Size=FileSize/N:
  98.      see above
  99.  
  100.   TimeOut/N:
  101.      If a transfer is stalled (-> the "---" display) AND AUTOEXIT/T is
  102.      used, the window will close after 'TimeOut' seconds.
  103.      Defaults to 10. You can use values from 0 to 30. 0 means, no timeout.
  104.  
  105.   Delay=UpdateDelay/N: New in v1.3
  106.      Update the display every x seconds. Defaults to 2.
  107.      You can use values from 1 to 10.
  108.  
  109.   SM=SizeMode: New in v1.4
  110.      It can be set to "KB" or "MB", to display the current size
  111.      and the filesize in Kilobytes (divided by 1024!) or MegaBytes
  112.      (divided by 1024*1024, with 3 numbers after the comma).
  113.      If its set to a different string, "bytes" are used.
  114.  
  115.   Com=Command: New in v1.4
  116.      This command will be executed if you press the "!" button!
  117.      You can use it f.e. to play the currently downloading mp3 song!
  118.      Default is "s:FSwatcher.bat".
  119.      The 's' and/or 'x' bit have to be set, if the command is
  120.      a shell-script!
  121.  
  122.   ComCon=CommandConsole: New in v1.4
  123.      This is used to specify a console window where the output of
  124.      the command is send to.
  125.      Default: CON:210/400/500/120/FSwatcher action command/CLOSE
  126.      If you don't want a window, use ComCon = NIL:.
  127.  
  128.  
  129.   BPSBar/T: New in v1.3
  130.      Should a small gauge showing the current bps relative to the
  131.      max bps be displayed?
  132.  
  133.   EXIT=AUTOEXIT/T
  134.      If means no finished-requester at the end and quit the program
  135.      after the is download finished.
  136.      EXIT YES
  137.  
  138.   QUIET/T [suggested by jah] New in v1.3
  139.      Should ALL error requesters be suppressed?
  140.      Well the "Dos.ReadArgs() failed!" isn't suppressed;-)
  141.